Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

enhance: use more descriptive names for database tools #334

Merged
merged 1 commit into from
Jan 13, 2025

Conversation

njhale
Copy link
Member

@njhale njhale commented Jan 10, 2025

To reduce confusion in both the LLM and tool maintainers, rename the following tools in the Database bundle:

  1. Tables -> List Database Tables
  2. Exec -> Exec Database Statement
  3. Query -> Run Database Query

Also fix tool descriptions to reflect the change from raw markdown output to JSON.

Addresses obot-platform/obot#1208

Since these tools are in the Capability category, the "blast radius" of this change includes the TableHandler implementation in obot and all tools/agents currently using them. That being the case, we
should hold-off on merging this change until the TableHandler implementation has been updated to the new tool names, or I keep duplicate tools that have the old names around until the handler implementation is updated.

njhale added a commit to njhale/obot that referenced this pull request Jan 10, 2025
@njhale njhale force-pushed the enhance/rename-database-exec branch from b178ee0 to d20beeb Compare January 10, 2025 23:28
Name: Tables
Description: List all tables in the SQLite database and return the results in markdown format
Name: List Tables
Description: List all tables in the SQLite database and return a JSON object containing the results
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"the results in markdown format"

Just to double check - you didnt change the return format right? You are just updating the description to match reality?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cjellick Yes, I'm just updating it to match a change Darren made a while back. We were originally returning markdown formatted data. It's been JSON for a while at this point.

njhale added a commit to njhale/obot that referenced this pull request Jan 13, 2025
@njhale njhale force-pushed the enhance/rename-database-exec branch from d20beeb to 63e4fd4 Compare January 13, 2025 17:31
To reduce confusion in both the LLM and tool maintainers, rename the
following tools in the `Database` bundle:

1. `Tables` -> `List Database Tables`
2. `Exec` -> `Exec Database Statement`
3. `Query` -> `Run Database Query`

Also fix tool descriptions to reflect the change from raw markdown
output to JSON.

Addresses obot-platform/obot#1208

Since these tools are in the `Capability` category, the "blast
radius" of this change includes
[the `TableHandler` implementation in obot](https://github.com/obot-platform/obot/blob/31ceab62d455bd798a069be034ea8effb1b41ac4/ui/user/src/lib/components/navbar/Tables.svelte#L8)
and all tools/agents currently using them. That being the case, we
should hold-off on merging this change until the `TableHandler`
implementation has been updated to the new tool names. I can also keep
the old tools around until the handler implementation is updated.

Signed-off-by: Nick Hale <[email protected]>
@njhale njhale force-pushed the enhance/rename-database-exec branch from 63e4fd4 to 55d2fcd Compare January 13, 2025 17:32
@njhale njhale merged commit 1646d2d into obot-platform:main Jan 13, 2025
njhale added a commit to obot-platform/obot that referenced this pull request Jan 13, 2025
Depends on obot-platform/tools#334
Addresses part of #1208

Signed-off-by: Nick Hale <[email protected]>
@njhale njhale deleted the enhance/rename-database-exec branch January 13, 2025 21:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants